DuKong - gRPC Gateway docs (1.0.0)

Download OpenAPI specification:Download

A REST interface for state queries, legacy transactions

Query

LastUpdated returns the last height the market map was updated at.

Responses

Market returns a market stored in the x/marketmap module.

query Parameters
currency_pair.Base
string
currency_pair.Quote
string

Responses

MarketMap returns the full market map stored in the x/marketmap module.

Responses

Params returns the current x/marketmap module parameters.

Responses

Get all the currency pairs the x/oracle module is tracking price-data for.

Responses

Get the mapping of currency pair ID -> currency pair. This is useful for indexers that have access to the ID of a currency pair, but no way to get the underlying currency pair from it.

Responses

Given a CurrencyPair (or its identifier) return the latest QuotePrice for that CurrencyPair.

query Parameters
currency_pair
string

CurrencyPair represents the pair that the user wishes to query.

Responses

GetPrices

query Parameters
currency_pair_ids
Array of strings

Responses

Queries all blacklisted denoms

Responses

Queries a specific rate limit by channel ID and denom Ex: - /ratelimit/{channel_id}/by_denom?denom={denom}

path Parameters
channel_id
required
string
query Parameters
denom
string

Responses

Queries all rate limits

Responses

Queries all the rate limits for a given chain

path Parameters
chain_id
required
string

Responses

Queries all the rate limits for a given channel ID

path Parameters
channel_id
required
string

Responses

Queries all whitelisted address pairs

Responses

Parameters queries the parameters of the module.

Responses

DenomAuthorityMetadata defines a gRPC query method for fetching DenomAuthorityMetadata for a particular denom.

path Parameters
creator
required
string
subdenom
required
string

Responses

BeforeSendHookAddress defines a gRPC query method for getting the address registered for the before send hook.

path Parameters
creator
required
string
subdenom
required
string

Responses

DenomsFromCreator defines a gRPC query method for fetching all denominations created by a specific admin/creator.

path Parameters
creator
required
string

Responses

Params defines a gRPC query method that returns the tokenfactory module's parameters.

Responses

GasPrice returns the current feemarket module gas price for specified denom.

path Parameters
denom
required
string

denom we are querying gas price in

Responses

GasPrices returns the current feemarket module list of gas prices in all available denoms.

Responses

Params returns the current feemarket module parameters.

Responses

State returns the current feemarket module state.

Responses

AccountInfo queries account info which is common to all account types.

Since: cosmos-sdk 0.47

path Parameters
address
required
string

address is the account address string.

Responses

Accounts returns all the existing accounts.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Since: cosmos-sdk 0.43

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Account returns account details based on address.

path Parameters
address
required
string

address defines the address to query for.

Responses

AccountAddressByID returns account address based on account number.

Since: cosmos-sdk 0.46.2

path Parameters
id
required
string <int64>

Deprecated, use account_id instead

id is the account number of the address to be queried. This field should have been an uint64 (like all account numbers), and will be updated to uint64 in a future version of the auth query.

query Parameters
account_id
string <uint64>

account_id is the account number of the address to be queried.

Since: cosmos-sdk 0.47

Responses

Bech32Prefix queries bech32Prefix

Since: cosmos-sdk 0.46

Responses

AddressBytesToString converts Account Address bytes to string

Since: cosmos-sdk 0.46

path Parameters
address_bytes
required
string <byte>

Responses

AddressStringToBytes converts Address string to bytes

Since: cosmos-sdk 0.46

path Parameters
address_string
required
string

Responses

ModuleAccounts returns all the existing module accounts.

Since: cosmos-sdk 0.46

Responses

ModuleAccountByName returns the module account info by module name

path Parameters
name
required
string

Responses

Params queries all parameters.

Responses

Returns list of `Authorization`, granted to the grantee by the granter.

query Parameters
granter
string
grantee
string
msg_type_url
string

Optional, msg_type_url, when set, will query only grants matching given msg type.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

GranteeGrants returns a list of `GrantAuthorization` by grantee.

Since: cosmos-sdk 0.46

path Parameters
grantee
required
string
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

GranterGrants returns list of `GrantAuthorization`, granted by granter.

Since: cosmos-sdk 0.46

path Parameters
granter
required
string
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

AllBalances queries the balance of all coins for a single account.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

path Parameters
address
required
string

address is the address to query balances for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

resolve_denom
boolean

resolve_denom is the flag to resolve the denom into a human-readable form from the metadata.

Since: cosmos-sdk 0.50

Responses

Balance queries the balance of a single coin for a single account.

path Parameters
address
required
string

address is the address to query balances for.

query Parameters
denom
string

denom is the coin denom to query balances for.

Responses

DenomOwners queries for all account addresses that own a particular token denomination.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Since: cosmos-sdk 0.46

path Parameters
denom
required
string

denom defines the coin denomination to query all account holders for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DenomOwnersByQuery queries for all account addresses that own a particular token denomination.

Since: cosmos-sdk 0.50.3

query Parameters
denom
string

denom defines the coin denomination to query all account holders for.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DenomsMetadata queries the client metadata for all registered coin denominations.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DenomMetadata queries the client metadata of a given coin denomination.

path Parameters
denom
required
string

denom is the coin denom to query the metadata for.

Responses

DenomMetadataByQueryString queries the client metadata of a given coin denomination.

query Parameters
denom
string

denom is the coin denom to query the metadata for.

Responses

Params queries the parameters of x/bank module.

Responses

SendEnabled queries for SendEnabled entries.

This query only returns denominations that have specific SendEnabled settings. Any denomination that does not have a specific setting will use the default params.default_send_enabled, and will not be returned by this query.

Since: cosmos-sdk 0.47

query Parameters
denoms
Array of strings

denoms is the specific denoms you want look up. Leave empty to get all entries.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

SpendableBalances queries the spendable balance of all coins for a single account.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Since: cosmos-sdk 0.46

path Parameters
address
required
string

address is the address to query spendable balances for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

SpendableBalanceByDenom queries the spendable balance of a single denom for a single account.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Since: cosmos-sdk 0.47

path Parameters
address
required
string

address is the address to query balances for.

query Parameters
denom
string

denom is the coin denom to query balances for.

Responses

TotalSupply queries the total supply of all coins.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

SupplyOf queries the supply of a single coin.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

query Parameters
denom
string

denom is the coin denom to query balances for.

Responses

CommunityPool queries the community pool coins.

Responses

DelegationTotalRewards queries the total rewards accrued by each validator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

DelegationRewards queries the total rewards accrued by a delegation.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

validator_address
required
string

validator_address defines the validator address to query for.

Responses

DelegatorValidators queries the validators of a delegator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

DelegatorWithdrawAddress queries withdraw address of a delegator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

Params queries params of the distribution module.

Responses

ValidatorDistributionInfo queries validator commission and self-delegation rewards for validator

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

Responses

ValidatorCommission queries accumulated commission for a validator.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

Responses

ValidatorOutstandingRewards queries rewards of a validator address.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

Responses

ValidatorSlashes queries slash events of a validator.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

query Parameters
starting_height
string <uint64>

starting_height defines the optional starting height to query the slashes.

ending_height
string <uint64>

starting_height defines the optional ending height to query the slashes.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

AllEvidence queries all evidence.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Evidence queries evidence based on evidence hash.

path Parameters
hash
required
string

hash defines the evidence hash of the requested evidence.

Since: cosmos-sdk 0.47

query Parameters
evidence_hash
string <byte>

evidence_hash defines the hash of the requested evidence. Deprecated: Use hash, a HEX encoded string, instead.

Responses

Allowance returns granted allwance to the grantee by the granter.

path Parameters
granter
required
string

granter is the address of the user granting an allowance of their funds.

grantee
required
string

grantee is the address of the user being granted an allowance of another user's funds.

Responses

Allowances returns all the grants for the given grantee address.

path Parameters
grantee
required
string
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

AllowancesByGranter returns all the grants given by an address

Since: cosmos-sdk 0.46

path Parameters
granter
required
string
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Params queries all parameters of the gov module.

path Parameters
params_type
required
string

params_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

Responses

Proposals queries all proposals based on given status.

query Parameters
proposal_status
string
Default: "PROPOSAL_STATUS_UNSPECIFIED"
Enum: "PROPOSAL_STATUS_UNSPECIFIED" "PROPOSAL_STATUS_DEPOSIT_PERIOD" "PROPOSAL_STATUS_VOTING_PERIOD" "PROPOSAL_STATUS_PASSED" "PROPOSAL_STATUS_REJECTED" "PROPOSAL_STATUS_FAILED"

proposal_status defines the status of the proposals.

  • PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.
  • PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
  • PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
  • PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
  • PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
  • PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
voter
string

voter defines the voter address for the proposals.

depositor
string

depositor defines the deposit addresses from the proposals.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Proposal queries proposal details based on ProposalID.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Deposits queries all deposits of a single proposal.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Deposit queries single deposit information based on proposalID, depositor address.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

depositor
required
string

depositor defines the deposit addresses from the proposals.

Responses

TallyResult queries the tally of a proposal vote.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Votes queries votes of a given proposal.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Vote queries voted information based on proposalID, voterAddr.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

voter
required
string

voter defines the voter address for the proposals.

Responses

AnnualProvisions current minting annual provisions value.

Responses

Inflation returns the current minting inflation value.

Responses

Params returns the total set of minting parameters.

Responses

Params queries a specific parameter of a module, given its subspace and key.

query Parameters
subspace
string

subspace defines the module to query the parameter for.

key
string

key defines the key of the parameter in the subspace.

Responses

Subspaces queries for all registered subspaces and all keys for a subspace.

Since: cosmos-sdk 0.46

Responses

Params queries the parameters of slashing module

Responses

SigningInfos queries signing info of all validators

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

SigningInfo queries the signing info of given cons address

path Parameters
cons_address
required
string

cons_address is the address to query signing info of

Responses

DelegatorDelegations queries all delegations of a given delegator address.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Redelegations queries redelegations of given address.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

query Parameters
src_validator_addr
string

src_validator_addr defines the validator address to redelegate from.

dst_validator_addr
string

dst_validator_addr defines the validator address to redelegate to.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DelegatorValidators queries all validators info for given delegator address.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

DelegatorValidator queries validator info for given delegator validator pair.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

validator_addr
required
string

validator_addr defines the validator address to query for.

Responses

HistoricalInfo queries the historical info for given height.

path Parameters
height
required
string <int64>

height defines at which height to query the historical info.

Responses

Parameters queries the staking parameters.

Responses

Pool queries the pool info.

Responses

Validators queries all validators that match the given status.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

query Parameters
status
string

status enables to query for validators matching a given status.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Validator queries validator info for given validator address.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

Responses

ValidatorDelegations queries delegate info for given validator.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Delegation queries delegate info for given validator delegator pair.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

delegator_addr
required
string

delegator_addr defines the delegator address to query for.

Responses

UnbondingDelegation queries unbonding info for given validator delegator pair.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

delegator_addr
required
string

delegator_addr defines the delegator address to query for.

Responses

ValidatorUnbondingDelegations queries unbonding delegations of a validator.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

AppliedPlan queries a previously applied upgrade plan by its name.

path Parameters
name
required
string

name is the name of the applied plan to query for.

Responses

Returns the account with authority to conduct upgrades

Since: cosmos-sdk 0.46

Responses

CurrentPlan queries the current upgrade plan.

Responses

ModuleVersions queries the list of module versions from state.

Since: cosmos-sdk 0.43

query Parameters
module_name
string

module_name is a field to query a specific module consensus version from state. Leaving this empty will fetch the full list of module versions from state.

Responses

UpgradedConsensusState queries the consensus state that will serve as a trusted kernel for the next version of this chain. It will only be stored at the last height of this chain. UpgradedConsensusState RPC not supported with legacy querier This rpc is deprecated now that IBC has its own replacement (https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)

path Parameters
last_height
required
string <int64>

last height of the current chain must be sent in request as this is the height under which next consensus state is stored

Responses

FeeEnabledChannel returns true if the provided port and channel identifiers belong to a fee enabled channel

path Parameters
channel_id
required
string

unique channel identifier

port_id
required
string

unique port identifier

Responses

Gets all incentivized packets for a specific channel

path Parameters
channel_id
required
string
port_id
required
string
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

query_height
string <uint64>

Height to query at.

Responses

CounterpartyPayee returns the registered counterparty payee for forward relaying

path Parameters
channel_id
required
string

unique channel identifier

relayer
required
string

the relayer address to which the counterparty is registered

Responses

Payee returns the registered payee address for a specific channel given the relayer address

path Parameters
channel_id
required
string

unique channel identifier

relayer
required
string

the relayer address to which the distribution address is registered

Responses

IncentivizedPacket returns all packet fees for a packet given its identifier

path Parameters
packet_id.channel_id
required
string

channel unique identifier

packet_id.port_id
required
string

channel port identifier

packet_id.sequence
required
string <uint64>

packet sequence

query Parameters
query_height
string <uint64>

block height at which to query.

Responses

TotalAckFees returns the total acknowledgement fees for a packet given its identifier

path Parameters
packet_id.channel_id
required
string

channel unique identifier

packet_id.port_id
required
string

channel port identifier

packet_id.sequence
required
string <uint64>

packet sequence

Responses

TotalRecvFees returns the total receive fees for a packet given its identifier

path Parameters
packet_id.channel_id
required
string

channel unique identifier

packet_id.port_id
required
string

channel port identifier

packet_id.sequence
required
string <uint64>

packet sequence

Responses

TotalTimeoutFees returns the total timeout fees for a packet given its identifier

path Parameters
packet_id.channel_id
required
string

channel unique identifier

packet_id.port_id
required
string

channel port identifier

packet_id.sequence
required
string <uint64>

packet sequence

Responses

FeeEnabledChannels returns a list of all fee enabled channels

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

query_height
string <uint64>

block height at which to query.

Responses

IncentivizedPackets returns all incentivized packets and their associated fees

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

query_height
string <uint64>

block height at which to query.

Responses

InterchainAccount returns the interchain account address for a given owner address on a given connection

path Parameters
owner
required
string
connection_id
required
string

Responses

Params queries all parameters of the ICA controller submodule.

Responses

Params queries all parameters of the ICA host submodule.

Responses

EscrowAddress returns the escrow address for a particular port and channel id.

path Parameters
channel_id
required
string

unique channel identifier

port_id
required
string

unique port identifier

Responses

DenomHash queries a denomination hash information.

path Parameters
trace
required
string

The denomination trace ([port_id]/[channel_id])+/[denom]

Responses

TotalEscrowForDenom returns the total amount of tokens in escrow based on the denom.

path Parameters
denom
required
string

Responses

Params queries all parameters of the ibc-transfer module.

Responses

Channels queries all the IBC channels of a chain.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Channel queries an IBC Channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

ChannelClientState queries for the client state for the channel associated with the provided channel identifiers.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

ChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

revision_number
required
string <uint64>

revision number of the consensus state

revision_height
required
string <uint64>

revision height of the consensus state

Responses

NextSequenceReceive returns the next receive sequence for a given channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

NextSequenceSend returns the next send sequence for a given channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

PacketAcknowledgements returns all the packet acknowledgements associated with a channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

packet_commitment_sequences
Array of strings <uint64>

list of packet sequences.

Responses

PacketAcknowledgement queries a stored packet acknowledgement hash.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

PacketCommitments returns all the packet commitments hashes associated with a channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

UnreceivedAcks returns all the unreceived IBC acknowledgements associated with a channel and sequences.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

packet_ack_sequences
required
Array of strings <uint64> non-empty

list of acknowledgement sequences

Responses

UnreceivedPackets returns all the unreceived IBC packets associated with a channel and sequences.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

packet_commitment_sequences
required
Array of strings <uint64> non-empty

list of packet sequences

Responses

PacketCommitment queries a stored packet commitment hash.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

PacketReceipt queries if a given packet sequence has been received on the queried chain

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

Upgrade returns the upgrade for a given port and channel id.

path Parameters
channel_id
required
string
port_id
required
string

Responses

UpgradeError returns the error receipt if the upgrade handshake failed.

path Parameters
channel_id
required
string
port_id
required
string

Responses

ConnectionChannels queries all the channels associated with a connection end.

path Parameters
connection
required
string

connection unique identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

ChannelParams queries all parameters of the ibc channel submodule.

Responses

ClientStates queries all the IBC light clients of a chain.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

ClientState queries an IBC light client.

path Parameters
client_id
required
string

client state unique identifier

Responses

Status queries the status of an IBC client.

path Parameters
client_id
required
string

client unique identifier

Responses

ConsensusStates queries all the consensus state associated with a given client.

path Parameters
client_id
required
string

client identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

ConsensusStateHeights queries the height of every consensus states associated with a given client.

path Parameters
client_id
required
string

client identifier

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

ConsensusState queries a consensus state associated with a client state at a given height.

path Parameters
client_id
required
string

client identifier

revision_number
required
string <uint64>

consensus state revision number

revision_height
required
string <uint64>

consensus state revision height

query Parameters
latest_height
boolean

latest_height overrides the height field and queries the latest stored ConsensusState.

Responses

ClientParams queries all parameters of the ibc client submodule.

Responses

UpgradedClientState queries an Upgraded IBC light client.

Responses

UpgradedConsensusState queries an Upgraded IBC consensus state.

Responses

VerifyMembership queries an IBC light client for proof verification of a value at a given key path.

Request Body schema: application/json
client_id
string

client unique identifier.

proof
string <byte>

the proof to be verified by the client.

object (Height is a monotonically increasing data type that can be compared against another Height for the purposes of updating and freezing clients)

Normally the RevisionHeight is incremented at each height while keeping RevisionNumber the same. However some consensus algorithms may choose to reset the height in certain conditions e.g. hard forks, state-machine breaking changes In these cases, the RevisionNumber is incremented so that height continues to be monitonically increasing even as the RevisionHeight gets reset

Please note that json tags for generated Go code are overridden to explicitly exclude the omitempty jsontag. This enforces the Go json marshaller to always emit zero values for both revision_number and revision_height.

value
string <byte>

the value which is proven.

time_delay
string <uint64> (optional time delay)
block_delay
string <uint64> (optional block delay)
object (MerklePath is the path used to verify commitment proofs, which can be an arbitrary structured object (defined by a commitment type). MerklePath is represented from root-to-leaf)

the commitment key path.

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "proof": "string",
  • "proof_height":
    {
    },
  • "value": "string",
  • "time_delay": "string",
  • "block_delay": "string",
  • "merkle_path":
    {
    }
}

ClientConnections queries the connection paths associated with a client state.

path Parameters
client_id
required
string

client identifier associated with a connection

Responses

Connections queries all the IBC connections of a chain.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Connection queries an IBC connection end.

path Parameters
connection_id
required
string

connection unique identifier

Responses

ConnectionClientState queries the client state associated with the connection.

path Parameters
connection_id
required
string

connection identifier

Responses

ConnectionConsensusState queries the consensus state associated with the connection.

path Parameters
connection_id
required
string

connection identifier

revision_number
required
string <uint64>
revision_height
required
string <uint64>

Responses

ConnectionParams queries all parameters of the ibc connection submodule.

Responses

Service

ABCIQuery defines a query handler that supports ABCI queries directly to the application, bypassing Tendermint completely. The ABCI query must contain a valid and supported path, including app, custom, p2p, and store.

Since: cosmos-sdk 0.46

query Parameters
data
string <byte>
path
string
height
string <int64>
prove
boolean

Responses

GetLatestBlock returns the latest block.

Responses

GetBlockByHeight queries block for given height.

path Parameters
height
required
string <int64>

Responses

GetNodeInfo queries the current node info.

Responses

GetSyncing queries node syncing.

Responses

GetLatestValidatorSet queries latest validator-set.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

GetValidatorSetByHeight queries validator-set at a given height.

path Parameters
height
required
string <int64>
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

TxDecode decodes the transaction.

Since: cosmos-sdk 0.47

Request Body schema: application/json
tx_bytes
string <byte>

tx_bytes is the raw transaction.

Responses

Request samples

Content type
application/json
{
  • "tx_bytes": "string"
}

TxDecodeAmino decodes an Amino transaction from encoded bytes to JSON.

Since: cosmos-sdk 0.47

Request Body schema: application/json
amino_binary
string <byte>

Responses

Request samples

Content type
application/json
{
  • "amino_binary": "string"
}

TxEncode encodes the transaction.

Since: cosmos-sdk 0.47

Request Body schema: application/json
object (cosmos.tx.v1beta1.Tx)

Tx is the standard type used for broadcasting transactions.

Responses

Request samples

Content type
application/json
{
  • "tx":
    {
    }
}

TxEncodeAmino encodes an Amino transaction from JSON to encoded bytes.

Since: cosmos-sdk 0.47

Request Body schema: application/json
amino_json
string

Responses

Request samples

Content type
application/json
{
  • "amino_json": "string"
}

Simulate simulates executing a transaction for estimating gas usage.

Request Body schema: application/json
object (cosmos.tx.v1beta1.Tx)

Tx is the standard type used for broadcasting transactions.

tx_bytes
string <byte>

tx_bytes is the raw transaction.

Since: cosmos-sdk 0.43

Responses

Request samples

Content type
application/json
{
  • "tx":
    {
    },
  • "tx_bytes": "string"
}

GetTxsEvent fetches txs by event.

query Parameters
events
Array of strings

events is the list of transaction event type. Deprecated post v0.47.x: use query instead, which should contain a valid events query.

pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

order_by
string
Default: "ORDER_BY_UNSPECIFIED"
Enum: "ORDER_BY_UNSPECIFIED" "ORDER_BY_ASC" "ORDER_BY_DESC"
  • ORDER_BY_UNSPECIFIED: ORDER_BY_UNSPECIFIED specifies an unknown sorting order. OrderBy defaults to ASC in this case.
  • ORDER_BY_ASC: ORDER_BY_ASC defines ascending order
  • ORDER_BY_DESC: ORDER_BY_DESC defines descending order
page
string <uint64>

page is the page number to query, starts at 1. If not provided, will default to first page.

limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

query
string

query defines the transaction event query that is proxied to Tendermint's TxSearch RPC method. The query must be valid.

Since cosmos-sdk 0.50

Responses

BroadcastTx broadcast transaction.

Request Body schema: application/json
tx_bytes
string <byte>

tx_bytes is the raw transaction.

mode
string
Default: "BROADCAST_MODE_UNSPECIFIED"
Enum: "BROADCAST_MODE_UNSPECIFIED" "BROADCAST_MODE_BLOCK" "BROADCAST_MODE_SYNC" "BROADCAST_MODE_ASYNC"

BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC method.

  • BROADCAST_MODE_UNSPECIFIED: zero-value for mode ordering
  • BROADCAST_MODE_BLOCK: DEPRECATED: use BROADCAST_MODE_SYNC instead, BROADCAST_MODE_BLOCK is not supported by the SDK from v0.47.x onwards.
  • BROADCAST_MODE_SYNC: BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for a CheckTx execution response only.
  • BROADCAST_MODE_ASYNC: BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns immediately.

Responses

Request samples

Content type
application/json
{
  • "tx_bytes": "string",
  • "mode": "BROADCAST_MODE_UNSPECIFIED"
}

GetBlockWithTxs fetches a block with decoded txs.

Since: cosmos-sdk 0.45.2

path Parameters
height
required
string <int64>

height is the height of the block to query.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total
boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

GetTx fetches a tx by hash.

path Parameters
hash
required
string

hash is the tx hash to query, encoded as a hex string.

Responses